The purpose of any system is basically to make any job/calculations easier and make manual work faster. Systems are usually made for reducing human error and increasing work efficiency by doing letting the software used to make calculations instead of the user to manually work out the numbers.
Program listing and coding
Program listing and coding is used to fix any bugs found later on and they can be found in the program coding.
Programming language used
Program language used is basically the language the program is made in and what language the program can ‘understand’
Algorithm (pseudo code and flowchart’s)
A program algorithm is a logical way of showing commands that the program follows this is usually shown as pseudo code and a flow chart
Input formats
Input formats are the format you are allowed to enter data into the program.
Hardware requirements
Hardware requirements are basically the computer systems hardware needs or in simple words its basically what hardware the system needs
Software requirements
Software requirements are the software’s that the system needs to function properly.
Minimum software requirements
These are the lowest the lowest memory your system can work on
Known bugs
Known bugs are basically the flaws that were found in the system
List of variables
The list of variables are used for showing the things that make the system more flexible
Sample runs
This is basically how the program responds to data and how the processed data should look like
Output formats
Output formats are the formats that the system presents the processed data
Validation rules
Validation rules are the rules that the system enforces to collect certain data
Meaning of error messages
The meaning of the error messages is that something has gone wrong somewhere in the system
User documentation
Purpose of the system/ program / software package – the purpose of the system should be outlined and what the system should be able to do.
How to log in/ out- This should contain information on how to login and out of the system and what data is needed to login example : username and password.
How to load /run the software- This should help the user use the software properly.
How to save the files- should contain documentation that should explain how to save files after a person has exited the program or while using the program
How to do a search – This should help the user to find out data/files easily.
How to sort data- This should tell them how would they save the data/files in specific places
How to do printouts- This should let the user to print out their records
How to add, delete or amend records-
Screen layouts (inputs)- This will show data on what inout devices are needed in order to operare the system e.g. qwerty keyboard.
Print layouts (outputs this should show how the printed receipt and show and what it should contain e.g. header and footer.
Hardware requirements- This should tell the user what requirements do they need to run/improve the hardware
Software requirements- This should tell the user what requirements do they need to run/improve the software
Sample runs ( with test data and results)- Sample runs test how the system will take diffrent types of data and make verification and validation checks.
Error handling/ meaning of errors- This should tell the user what is wrong with their software or
Troubleshooting guide / help lines/FAQs- This should help the user to understand more about the software.
Tutorials- This could help the new user, in which they are guided through each step of accomplishing particular tasks.
Technical documentation
- Purpose of the system
The purpose of any system is basically to make any job/calculations easier and make manual work faster. Systems are usually made for reducing human error and increasing work efficiency by doing letting the software used to make calculations instead of the user to manually work out the numbers.- Program listing and coding
Program listing and coding is used to fix any bugs found later on and they can be found in the program coding.- Programming language used
Program language used is basically the language the program is made in and what language the program can ‘understand’- Algorithm (pseudo code and flowchart’s)
A program algorithm is a logical way of showing commands that the program follows this is usually shown as pseudo code and a flow chart- Input formats
Input formats are the format you are allowed to enter data into the program.- Hardware requirements
Hardware requirements are basically the computer systems hardware needs or in simple words its basically what hardware the system needs- Software requirements
Software requirements are the software’s that the system needs to function properly.- Minimum software requirements
These are the lowest the lowest memory your system can work on- Known bugs
Known bugs are basically the flaws that were found in the system- List of variables
The list of variables are used for showing the things that make the system more flexible- Sample runs
This is basically how the program responds to data and how the processed data should look like- Output formats
Output formats are the formats that the system presents the processed data- Validation rules
Validation rules are the rules that the system enforces to collect certain data- Meaning of error messages
The meaning of the error messages is that something has gone wrong somewhere in the systemUser documentation
Purpose of the system/ program / software package – the purpose of the system should be outlined and what the system should be able to do.
How to log in/ out- This should contain information on how to login and out of the system and what data is needed to login example : username and password.
How to load /run the software- This should help the user use the software properly.
How to save the files- should contain documentation that should explain how to save files after a person has exited the program or while using the program
How to do a search – This should help the user to find out data/files easily.
How to sort data- This should tell them how would they save the data/files in specific places
How to do printouts- This should let the user to print out their records
How to add, delete or amend records-
Screen layouts (inputs)- This will show data on what inout devices are needed in order to operare the system e.g. qwerty keyboard.
Print layouts (outputs this should show how the printed receipt and show and what it should contain e.g. header and footer.
Hardware requirements- This should tell the user what requirements do they need to run/improve the hardware
Software requirements- This should tell the user what requirements do they need to run/improve the software
Sample runs ( with test data and results)- Sample runs test how the system will take diffrent types of data and make verification and validation checks.
Error handling/ meaning of errors- This should tell the user what is wrong with their software or
Troubleshooting guide / help lines/FAQs- This should help the user to understand more about the software.
Tutorials- This could help the new user, in which they are guided through each step of accomplishing particular tasks.